-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
basics of cloudflare / AWS / firebase deployment instructions #335
Conversation
Hmm, another case of puppeteer "failing" on Netlify?
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome guide @aholtzman , thank you so much !
Left a couple small comments but otherwise no real issues here. Will merge this once #314 is merged, which will introduce the top level guides page where this file can then be place.
@@ -0,0 +1,56 @@ | |||
## Cloudflare Workers Deployment | |||
|
|||
[Cloudflare Workers](https://workers.cloudflare.com/) is an excellent option as a CDN for deploying your Greenwood site, though if your are new to using this service consider deploying with [Netlify](https://www.netlify.com) as it is a simpler process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
though if your are new
I think this might mean to be "though if you are new"
|
||
When completed a url for workers subdomain will be printed in your terminal. | ||
|
||
To have automatic deployments whenever you push updates to your repo, you will need to configure GitHub actions to accomplish this, otherwise you can push updated manually but running the _build_ and _publish_ commands each time you wish to update the site. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you happen to have a link to one of those GitHub actions by chance? Might be cool to link here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have not yet tried this myself, but the Gatsby documentation for cloudflare deployment mentions this. I will be trying this out at work this week and can add an additional guide for this or append this one once I have it worked out.
Nice @aholtzman , looks like you were able to get it working. Maybe a cool "side" project for the Greenwood team would be to make a Docker container and GitHub Action for building Greenwood, to help support on the Chromium dependency. I'm sure it could also be made in such a way so as to apply to most CI environments (CircleCI, Travis). Will add it as an idea to the Trello board. 👍 |
www/pages/s3-cloudfront.md
Outdated
OPTIONS: "--acl public-read" | ||
``` | ||
|
||
In the same directory as main.yml create a file 'chromium-lib-install.sh' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, will definitely make an issue for this. Would be annoying if everyone needs to set these up all the time if they want to use our project. I know other projects like Scully use puppeteer, I wonder if they also need to do the same thing? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aholtzman
I think you may have run an npm install
inadvertently. Can you revert the addition of package-lock.json and the changes to package.json please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aholtzman
Merged @hutchgrant 's work, if you can just pull in master and move your content into pages/guides, then you can use markdown to organize your content within the menu.
76ee9df
to
30eadb6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a big deal, but the position of the carrot looks off in wider breakpoints.
Maybe something to circle back to as part of #325 / #112 ?
cc: @hutchgrant
also, if possible on PRs let's please try and reference the issue number in the branch name 🙏 , e.g. guide/issue-123-guide-for-xyz
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aholtzman
One thing I really liked about the guide @hutchgrant put together was the addition of screenshoots. Sometimes really helpful for settings / admin panels in these kinds of tools. Just a thought, maybe something you would mind adding in a follow PR?
Suggestions:
- AWS: AWS CloudFront for CDN
- AWS: Setup S3 for Hosting
- Firebase: Deploy on Firebase (for the new project flow)
- Firebase: Auto Deployment with GitHub Actions (adding the
FIREBASE_TOKEN
)
Related Issue
resolves #326
Summary of Changes
there was no guides/tutorials directors in the master branch at this time, so just added to the 'pages' folder for now.